home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-04 / cref11.zip / CREF.DOC < prev    next >
Text File  |  1992-06-26  |  17KB  |  405 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                                     CREF
  12.                             Charts of Reference
  13.                                 Version 1.1
  14.  
  15.                        (C)Copyright 1992 Rand Nowell
  16.  
  17.                              RaLin Enterprises
  18.                         "Putting Bits Together" (tm)
  19.  
  20.                          - Program Documentation -
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.                                 MANUAL INDEX
  30.  
  31.  
  32.  
  33.            LEGAL STUFF..........................................0
  34.            SHAREWARE ?..........................................1
  35.            SYSTEM REQUIREMENTS..................................1
  36.            WHERE TO PUT CREF....................................1
  37.            STARTUP:
  38.                Save Screen......................................1
  39.                No Save Screen...................................1
  40.            TSR VERSION........................................1,4
  41.            SELECTING MENU ITEMS.................................2
  42.            HOT KEY SWITCHING....................................2
  43.            THE CHARTS: The Information.
  44.                <K> Keys..Extended Keys..........................2
  45.                <T> Attr..Text Attributes........................2
  46.                <C> Char..Character Codes......................2,3
  47.                <A> Pascal..Color Codes..........................3
  48.                <N> Ansi..Ansi Escape Codes......................3
  49.                <S> Ascii..Ascii Text Color Codes................3
  50.                <Q> Quit..Exiting CREF...........................3
  51.            MACROS: Calling from programs.
  52.                Qedit............................................3
  53.                Boxer..........................................3,4
  54.                Qmodem...........................................4
  55.                Other Programs...................................4
  56.            REGISTRATION...(or lack of)........................4,5
  57.            SUGGESTIONS..........................................5
  58.            ACKNOWLEDGEMENTS.....................................5
  59.            DEVELOPMENT..........................................5
  60.            SUPPORT..............................................5
  61.  
  62.  
  63.  
  64.    Copyright:
  65.  
  66.    CREF 1.0  is not a Public Domain or Free program. It is the
  67.    Copyrighted (c) 1992 work of Rand Nowell dba Ralin Enterprises.
  68.    All rights are reserved. Copying, duplicating, selling or otherwise
  69.    distributing this product except as noted in the Distribution Policy
  70.    below is a violation of Federal Copyright Law.
  71.  
  72.    You are authorized to evaluate the program for a period of 30 days.
  73.    If after 30 days you wish to continue using the program, registration
  74.    IS REQUESTED. Please see REGCOM.DOC
  75.  
  76.    Distribution:
  77.  
  78.    1. Feel free to distribute the Shareware version of this program as
  79.       often as you like to any interested parties. Distribution to
  80.       Electronic Bullentin Boards is encouraged.
  81.    2. Please do not distribute this program without all the original
  82.       related files such as documentation, readme files, registration
  83.       forms etc.
  84.    3. Please distribute ONLY the original authenticated ZIP format file.
  85.    4. Please obtain our written permission before including the program
  86.       with any "bundled" software packages.
  87.    5. Please do not accept payment for the program; a copying fee of
  88.       $5.00 per diskette may be charged by a non-profit user-group.
  89.    6. Please do not alter the program or documentation in any way.
  90.    7. Individuals, groups, vendors or other software distribution
  91.       companies which market diskettes containg shareware or test-drive
  92.       evaluation programs, for profit, must obtain written permission
  93.       from RaLin Enterprises prior to distribution.
  94.  
  95.     DISTRIBUTION of the REGISTERED version of this program is in
  96.     violation of the license agreement and copyright law.
  97.  
  98.     ************************* DISCLAIMER *****************************
  99.  
  100.     This program is supplied "as is" without warrenty of any kind. The
  101.     entire risk of using, and results from the use of, is assumed by you
  102.     the user.  You assume all costs of repair, servicing and corrections
  103.     stemming from the use of this program.
  104.     Rand Nowell and/or RaLin Enterprises, or any other associated
  105.     company of the program author will not be held liable for any
  106.     damages from the use of this program. No warrenties are expressed or
  107.     implied.
  108.     ********************************************************************
  109.     To the original licensee of the REGISTERD version of CREF 1.0
  110.     RaLin Enterprises DOES warrant that the program disk(s) on which the
  111.     program is recorded, be free from defects in material and
  112.     workmanship under normal use and service for a period of (90) ninety
  113.     days from date of delivery as evidenced by your receipt. Our entire
  114.     liability and your exclusive remedy shall be replacement of the
  115.     deffective disk not meeting the standards of this limited warranty.
  116.  
  117.   
  118. CREF.DOC         Charts Of Reference Manual                    Page   1
  119.  
  120.  SHAREWARE?
  121.  
  122.          What is it ?  A shareware program is one that the author
  123.          distributes for the people to try, free of charge. Usually the
  124.          author will set a time limit on this "Free Trial" and if you
  125.          continue to use the product after this time period, you are usually
  126.          expected to pay a small registration fee. Unlike commercial
  127.          software where you Buy then Try, this allows you to evaluate the
  128.          program without investing your hard earned money, then if you like
  129.          it and find it useful and only then, do you register it. If you do
  130.          not intend to register a shareware program, you should stop using
  131.          it, and delete it from your system. What a deal!
  132.  
  133.  
  134.  SYSTEM REQUIREMENTS:
  135.  
  136.         Memory:       Runs in minimum amount of memory. If calling from
  137.                       within another program then figure on CREF using
  138.                       about another 52k of memory.
  139.  
  140.         Video:        Requires a graphics card and color monitor.
  141.  
  142.         Dos Version:  Will work from 3.0 up, not tested in lower versions
  143.                       but should work with 2.0 + There is no version
  144.                       checking within the program.
  145.  
  146.  WHERE TO PUT IT:
  147.  
  148.         CREF should be stored in a directory that is included in your path
  149.         statement. This is especially true if you are going to be calling it
  150.         from within another program. Placing CREF in a "PATH" directory will
  151.         allow it to be called from anywhere in your system.
  152.  
  153.  STARTUP:
  154.  
  155.       Command syntax: CREF [/s]
  156.  
  157.       CREF alone will call the program without saving the underlying screen,
  158.       the screen is cleared on starting and on completion.
  159.  
  160.       [/s] If you wish to preserve your underlying screen, so that you can
  161.       view it while using CREF, use the switch /s  the 's' MUST be lower
  162.       case, and the switch must have a space between it and CREF.
  163.        The /s switch has no effect when CREF is called from within another
  164.        program, as that program performs a Dos SHELL to run CREF, and should
  165.        save its own screen. (See the MACROS section.)
  166.  
  167.  
  168.        Once CREF has started you will see a Title and Copyright notice at
  169.        the top of the screen, and just below it to the far left will be the
  170.        CREF menu.
  171.  
  172.   Information at your fingertips!
  173.  
  174.  
  175. CREF.DOC         Charts Of Reference Manual                    Page  2
  176.  
  177.  
  178.                    Artery....The study of fine paintings.
  179.  
  180.  SELECTING MENU ITEMS:
  181.  
  182.        There are several ways to select items on the Menu.
  183.        1. Use the up/down arrow keys to highlight your choice,
  184.           then press <Enter>.
  185.  
  186.        2. Press the highlighted letter of a Menu item.
  187.  
  188.        3. Using the arrow keys, move the highlight bar to a selection, then
  189.           press the right or left arrow key.
  190.  
  191.  HOT KEY SWITCHING:
  192.  
  193.        Once you have a chart on the screen, you may put it away by pressing
  194.        ESC. This returns you to the Menu to make another choice or to Exit.
  195.        But it is not necessary to return to the Menu to view another chart,
  196.        when any chart (except the Character charts) is active, you can press
  197.        the HotKey of any Menu choice and replace the current chart with the
  198.        one called. The exception to this HotKey trick is the Character
  199.        Charts...there are three of them, pressing any key other than escape
  200.        will rotate between them, pressing Esc exits back to the Menu. So you
  201.        must return to the Menu to select another chart when viewing the
  202.        Character Charts.
  203.  
  204.      Example:  Suppose you are viewing the P(a)scal chart, pressing the
  205.                letter (n) would immediately display the A(n)si chart.
  206.                * Its a neat trick! *
  207.  
  208.                  Nitrate......different than the day rate.
  209.  
  210.   THE CHARTS:
  211.  
  212.    <K> Keys:  The Keys chart is a full screen display of Extended Key codes,
  213.        these are the codes generated when an Alt/Ctrl/Shft key combination
  214.        is pressed, also the 12 Function keys F1 - F12. When these
  215.        combination keys are pressed there are actually two codes produced,
  216.        the first is always 0 (thats zero) and the second is the decimal code
  217.        listed in this chart. Codes can also be referenced in Hexadecimal,
  218.        but this chart shows only the decimal codes. There is also a short
  219.        example of how to determine if an Extended key code has been
  220.        generated. This example is in Pascal format. Press Esc to put this
  221.        chart away and return to the Menu, or HotKey to another.
  222.  
  223.    <T> Attr:  The Attribute Chart shows the Background/Foreground decimal
  224.        codes. The first digit is the Background color, the second is the
  225.        foreground. These numbers are shown using Decimal and Hex format for
  226.        those situations where you need to use this format.
  227.  
  228.    <C> Char:  This produces a group of 3 screens showing the character
  229.        codes. Some of these would be entered with the Ctrl key, others would
  230.  
  231.   Information at your fingertips!
  232.  
  233.  
  234. CREF.DOC         Charts Of Reference Manual                    Page  3
  235.  
  236.        be entered using the Alt key and the number pad keys. If you were to
  237.        hold down the Alt key and, using the keys on the number key pad, type
  238.        251, it would produce the checkmark (√) such as this. Remember, when
  239.        using the Alt+Number method, the numbers must be entered using the
  240.        key pad to the right of the keyboard. It will not work using the
  241.        number keys at the top of the keyboard.
  242.        Pressing the spacebar will cycle through these 3 screens, pressing
  243.        Esc will exit to the Menu. You cannot HotKey to another chart from
  244.        the Character charts.
  245.  
  246.                           Tumor.....An extra pair.
  247.  
  248.    <A> Pascal:  This displays a chart of color numbers that can be used when
  249.        you need to specify both colors with one number. Using a Pascal
  250.        example again, TextAttr:=95 would produce bright white on magenta.
  251.  
  252.    <N> Ansi:  This chart displays many of the Ansi color codes that are
  253.        useful in assigning color to text in Dos batch files. The proper
  254.        syntax is also shown for such commands.
  255.  
  256.    <S> Ascii:  Here we have the Dos textcolor codes. This chart is somewhat
  257.        similar to the Attr chart above, but the color numbers are all in
  258.        decimal. A Pascal example would be TextBackground(5);TextColor(15)
  259.        would give us bright white on magenta.
  260.  
  261.    <Q> Quit: Last but not least is the Quit option. Exits CREF and returns
  262.        you to the calling program, or Dos. If the /s switch was used, your
  263.        screen will be restored to its startup state.
  264.  
  265.                           Hangnail.....A coathook.
  266.  
  267.  MACROS:
  268.  
  269.         Here a couple of macros for calling CREF from some popular programs.
  270.  
  271.     1. Qedit: Using Qconfig.exe and the qconfig.dat  assign  this macro to
  272.        the available key of your choice....
  273.  
  274.  MacroBegin SaveFile Dos 'CREF' Return Quit EditFile CurrentFileName Return
  275.  
  276.      This macro will save the file you are working on, shell to dos and run
  277.      CREF, then return to Qedit, reload you file, and put you right back
  278.      where you left off. This is the macro I use, and have used it several
  279.      times during the writing of this Manual.
  280.  
  281.      2. Boxer:  You must assign the commands to a macro key, here we are
  282.      assigning it to Ctrl-C, here are the steps.
  283.        a) Press F8
  284.        b) Press F9 (Boxers Dos Call key)
  285.        c) Type CREF
  286.        d) Press Enter
  287.        e) Once the CREF menu is displayed press (Q)uit
  288.        f) Press any key to return to Boxer
  289.        g) Press F8 again
  290.  
  291.   Information at your fingertips!
  292.  
  293.  
  294. CREF.DOC         Charts Of Reference Manual                    Page  4
  295.  
  296.        h) Enter a title for the macro, such as Calls Cref Charts.
  297.        * Thats it...your ready to call CREF from the Boxer Editor any time
  298.        you need it.
  299.  
  300.        3. Qmodem: You probably wouldn't need CREF to often here, but if you
  301.           are writing a script and want to use colors, access the CREF
  302.           Pascal chart for the proper color numbers. Remember to add 128 to
  303.           the color number if you want the foreground color to blink.
  304.  
  305.           NOTE: If you want to be able to call CREF when writing Qmodem
  306.           scripts, you will have to use another editor. Qmodem's editor
  307.           QMEdit won't allow macros, or a Dos shell. Configure the program
  308.           to call another editor such as Qedit.
  309.  
  310.                       Urine.....opposite of "Your Out"
  311.  
  312.           But you can call CREF from the terminal screen, press Alt-J to
  313.           call up the macro editor, choose a key combination to use, then
  314.           enter @shellx CREF and save. Then pressing that key combination
  315.           will shell out and load CREF. This is assuming that CREF can be
  316.           found by the system. (Refer back to Where To Put CREF.)
  317.  
  318.    As for setting up CREF to be called from any other programs, these
  319.    examples should give you an idea on how to set it up. Refer to the
  320.    particular programs documentation on how to set up external program
  321.    calls.
  322.  
  323.    TSR VERSION: The TSR version has been created! Please refer to the
  324.                 CREFR.DOC for any differences in the program.
  325.  
  326.    REGISTRATION:
  327.  
  328.                 You are not required to register CREF in order to use it.
  329.                 But if you find it useful, and would like to see it
  330.                 developed further, a registration of $5.00 or more would be
  331.                 appreciated!
  332.  
  333.                            Node.....Was aware of.
  334.  
  335.                 Registrations will show me that the program has been useful
  336.                 to others, and induce me to develop it further. If no one is
  337.                 interested in it enough to donate towards its continued
  338.                 development, then I won't pursue it any further.
  339.  
  340.                 If you send me $10.00 (or more <grin>) I will send you new
  341.                 copies of the programs on disk, you will also receive some
  342.                 more handy utilities from RaLin Enterprises...for FREE.
  343.  
  344.                 A registration form has been provided for anyone that wishes
  345.  
  346.   Information at your fingertips!
  347.  
  348.  
  349. CREF.DOC         Charts Of Reference Manual                    Page  5
  350.  
  351.                 to donate to the cause. <REGCOM.DOC>
  352.                 You will be recorded in our database as a registered user.
  353.                 You will receive notices of new  product releases.
  354.                 You will receive unlimited support for the product.....
  355.                 and anything else I can think of to treat you right!
  356.  
  357.   SUGGESTIONS:
  358.  
  359.           If you have some suggestions, or requests, pertaining to types of
  360.           charts to add to CREF, please use the Suggestion/Comments form
  361.           that is provided. <REGCOM.DOC>
  362.  
  363.           I do hope that CREF helps you in your work!
  364.  
  365.  ACKNOWLEDGEMENTS:
  366.  
  367.           Several products have been mentioned here, now we will pay respect
  368.           to the authors.....
  369.  
  370.   Pascal:  By Borland International...a fantastic programming language.
  371.   Qedit:   By SemWare...one of the BEST editors around.
  372.   Boxer:   By David R. Hamel....an awesome text editor...kudos to Dave!
  373.   Qmodem:  By Mustang Software...the premier Communications package.
  374.   CREF:    By Rand Nowell/RaLin Enterprises....wait a minute here.....
  375.  
  376.   DEVELOPMENT:
  377.  
  378.       CREF was written in Turbo Pascal. Borland International.
  379.  
  380.       Screens and menus generated by Saywhat! Screen Developer from
  381.       Software Science, a fantastic screen developer for multiple
  382.       programming languages and Dos batch files!
  383.  
  384.                       Medical Staff......doctors cane.
  385.  
  386.  
  387.   SUPPORT:
  388.  
  389.        I can be reached at the following:
  390.  
  391.        Phone: 510-651-0253  If I'm out leave a message. I return registered
  392.        users calls at my expense, otherwise it will be collect.
  393.  
  394.        NetMail: 1:/215/777  or  1:161/42   - Rand Nowell
  395.  
  396.        CIS:  76124,761
  397.  
  398.        Mail:  40728 Sundale Dr. Fremont, Ca. 94538
  399.  
  400.        FIDO:  Shareware Echo   - Rand Nowell
  401.  
  402.  
  403.    Information at your fingertips!
  404.  
  405.